Interface WebView

All Superinterfaces:
IPCObject
All Known Implementing Classes:
WebViewImpl

public interface WebView extends IPCObject
Information provided by the PKI file:

    \class WebView
    
    \brief WebView allows manipulation of WebViews such as the Instruction dialog and Script Modules.
    
    \example appWindow().getWebViewManager().getWebView("bca9d287-1eec-49a2-9bd2-ff83ef92f338")
    
Author:
Auto-generated
  • Method Details

    • getWebViewId

      UUID getWebViewId()
      Information provided by the PKI file:
      
          \brief Returns the UUID of this WebView.
          
          \return uuid, the UUID of this WebView.
          
              
      Returns:
      UUID Returns a UUID
    • evaluateToVariant

      String evaluateToVariant(String scriptSource)
      Information provided by the PKI file:
      
          \brief Evaluates the specified script.
          
          \param scriptSource, the path or source of the script.
          
          \return QString, returns the a unique string to match result from generated event.
          
              
      Parameters:
      scriptSource - Takes in a parameter of scriptSource
      Returns:
      String Returns a String
    • evaluateJavaScriptAsync

      void evaluateJavaScriptAsync(String scriptSource)
      Information provided by the PKI file:
      
          \brief Evaluates the specified script asynchronously.
          
          \param scriptSource, the path or source of the script.
          
              
      Parameters:
      scriptSource - Takes in a parameter of scriptSource
    • setHtml

      void setHtml(String html)
      Information provided by the PKI file:
      
          \brief Sets the HTML content of the WebView.
          
          \param html, the HTML content for the WebView.
          
              
      Parameters:
      html - Takes in a parameter of html
    • setUrl

      void setUrl(String url)
      Information provided by the PKI file:
      
          \brief Sets the URL of the WebView.
          
          \param url, the URL for the WebView.
          
              
      Parameters:
      url - Takes in a parameter of url
    • getUrl

      String getUrl()
      Information provided by the PKI file:
      
          \brief Returns the URL of the current page being displayed.
          
              
      Returns:
      String Returns a String
    • getRequestedUrl

      String getRequestedUrl()
      Information provided by the PKI file:
      
          \brief Returns the requested URL, which may be different than what getUrl() returns.
          
              
      Returns:
      String Returns a String
    • show

      void show()
      Information provided by the PKI file:
      
          \brief Shows the WebView.
          
              
    • hide

      void hide()
      Information provided by the PKI file:
      
          \brief Hides the WebView.
          
              
    • raise

      void raise()
      Information provided by the PKI file:
      
          \brief Shows the WebView on top of other windows.
          
              
    • setWindowTitle

      void setWindowTitle(String title)
      Information provided by the PKI file:
      
          \brief Sets the window title of the WebView.
          
          \param title, the title for the WebView.
          
              
      Parameters:
      title - Takes in a parameter of title
    • setGeometry

      void setGeometry(int x, int y, int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the window position and geometry of the WebView.
          
          \param x, the x-coordinate for the WebView.
          \param y, the y-coordinate for the WebView.
          \param width, the width for the WebView.
          \param height, the height for the WebView.
          
              
      Parameters:
      x - Takes in a parameter of x
      y - Takes in a parameter of y
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • getX

      int getX()
      Information provided by the PKI file:
      
          \brief Returns the x position of the webview.
          
              
      Returns:
      int Returns a int
    • getY

      int getY()
      Information provided by the PKI file:
      
          \brief Returns the y position of the webview.
          
              
      Returns:
      int Returns a int
    • getWidth

      int getWidth()
      Information provided by the PKI file:
      
          \brief Returns the width of the webview.
          
              
      Returns:
      int Returns a int
    • getHeight

      int getHeight()
      Information provided by the PKI file:
      
          \brief Returns the height of the webview.
          
              
      Returns:
      int Returns a int
    • setMaximumSize

      void setMaximumSize(int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the maximum size of the web view.
          
              
      Parameters:
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • setMaximumWidth

      void setMaximumWidth(int width)
      Information provided by the PKI file:
      
          \brief Sets the maximum width of the webview.
          
              
      Parameters:
      width - Takes in a parameter of width
    • setMaximumHeight

      void setMaximumHeight(int height)
      Information provided by the PKI file:
      
          \brief Sets the maximum height of the webview.
          
              
      Parameters:
      height - Takes in a parameter of height
    • getMaximumWidth

      int getMaximumWidth()
      Information provided by the PKI file:
      
          \brief Returns the maximum width of the webview.
          
              
      Returns:
      int Returns a int
    • getMaximumHeight

      int getMaximumHeight()
      Information provided by the PKI file:
      
          \brief Returns the maximum height of the webview.
          
              
      Returns:
      int Returns a int
    • setMinimumSize

      void setMinimumSize(int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the minimum size of the web view.
          
              
      Parameters:
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • setMinimumWidth

      void setMinimumWidth(int width)
      Information provided by the PKI file:
      
          \brief Sets the minimum width of the webview.
          
              
      Parameters:
      width - Takes in a parameter of width
    • setMinimumHeight

      void setMinimumHeight(int height)
      Information provided by the PKI file:
      
          \brief Sets the minimum height of the webview.
          
              
      Parameters:
      height - Takes in a parameter of height
    • getMinimumWidth

      int getMinimumWidth()
      Information provided by the PKI file:
      
          \brief Returns the minimum width of the webview.
          
              
      Returns:
      int Returns a int
    • getMinimumHeight

      int getMinimumHeight()
      Information provided by the PKI file:
      
          \brief Returns the minimum height of the webview.
          
              
      Returns:
      int Returns a int
    • setPreferredSize

      void setPreferredSize(int width, int height)
      Information provided by the PKI file:
      
          \brief Sets the preferred size of the webview.
          
              
      Parameters:
      width - Takes in a parameter of width
      height - Takes in a parameter of height
    • getPreferredWidth

      int getPreferredWidth()
      Information provided by the PKI file:
      
          \brief Returns the preferred width of the webview.
          
              
      Returns:
      int Returns a int
    • getPreferredHeight

      int getPreferredHeight()
      Information provided by the PKI file:
      
          \brief Returns the preferred height of the webview.
          
              
      Returns:
      int Returns a int
    • isFullScreen

      void isFullScreen()
      Information provided by the PKI file:
      
          \brief Returns whether the webview is shown in full screen mode.
          
              
    • showFullScreen

      void showFullScreen()
      Information provided by the PKI file:
      
          \brief Shows the webview in full-screen mode.
          
              
    • isMaximized

      void isMaximized()
      Information provided by the PKI file:
      
          \brief Returns whether the webview is maximized.
          
              
    • showMaximized

      void showMaximized()
      Information provided by the PKI file:
      
          \brief Shows the webview maximized.
          
              
    • isMinimized

      void isMinimized()
      Information provided by the PKI file:
      
          \brief Returns whether this widget is minimized (iconified).
          
              
    • showMinimized

      void showMinimized()
      Information provided by the PKI file:
      
          \brief Shows the webview minimized, as an icon.
          
              
    • showNormal

      void showNormal()
      Information provided by the PKI file:
      
          \brief Restores the widget after it has been maximized or minimized.
          
              
    • setWindowFlags

      void setWindowFlags(WindowFlags flags)
      Information provided by the PKI file:
      
          \brief Sets the window flags for the WebView.
          
          \param flags,       the window flags.
          Window flags:
          Widget = 0x00000000,
          Window = 0x00000001,
          Dialog = 0x00000002 | Window,
          Sheet = 0x00000004 | Window,
          Drawer = Sheet | Dialog,
          Popup = 0x00000008 | Window,
          Tool = Popup | Dialog,
          ToolTip = Popup | Sheet,
          SplashScreen = ToolTip | Dialog,
          Desktop = 0x00000010 | Window,
          SubWindow = 0x00000012,
          ForeignWindow = 0x00000020 | Window,
          CoverWindow = 0x00000040 | Window,
          
          WindowType_Mask = 0x000000ff,
          MSWindowsFixedSizeDialogHint = 0x00000100,
          MSWindowsOwnDC = 0x00000200,
          BypassWindowManagerHint = 0x00000400,
          X11BypassWindowManagerHint = BypassWindowManagerHint,
          FramelessWindowHint = 0x00000800,
          WindowTitleHint = 0x00001000,
          WindowSystemMenuHint = 0x00002000,
          WindowMinimizeButtonHint = 0x00004000,
          WindowMaximizeButtonHint = 0x00008000,
          WindowMinMaxButtonsHint = WindowMinimizeButtonHint | WindowMaximizeButtonHint,
          WindowContextHelpButtonHint = 0x00010000,
          WindowShadeButtonHint = 0x00020000,
          WindowStaysOnTopHint = 0x00040000,
          WindowTransparentForInput = 0x00080000,
          WindowOverridesSystemGestures = 0x00100000,
          WindowDoesNotAcceptFocus = 0x00200000,
          MaximizeUsingFullscreenGeometryHint = 0x00400000,
          
          CustomizeWindowHint = 0x02000000,
          WindowStaysOnBottomHint = 0x04000000,
          WindowCloseButtonHint = 0x08000000,
          MacWindowToolBarButtonHint = 0x10000000,
          BypassGraphicsProxyWidget = 0x20000000,
          NoDropShadowWindowHint = 0x40000000,
          WindowFullscreenButtonHint = 0x80000000,
          
          
          
          WindowOkButtonHint = 0x00080000,
          WindowCancelButtonHint = 0x00100000
          
              
      Parameters:
      flags - Takes in a parameter of flags
    • getWindowFlags

      WindowFlags getWindowFlags()
      Information provided by the PKI file:
      
          \brief Returns the window flags for the WebView. See setWindowFlags() for enum values.
          
              
      Returns:
      WindowFlags Returns a WindowFlags
    • setWindowModality

      void setWindowModality(WindowModality modality)
      Information provided by the PKI file:
      
          \brief Sets the window modality for the WebView.
          
          \param modality,    the window modality.
          Window flags:       Qt::NonModal = 0,
          Qt::WindowModal = 1,
          Qt::ApplicationModal = 2,
          
              
      Parameters:
      modality - Takes in a parameter of modality
    • setCanClose

      void setCanClose(boolean bCanClose)
      Information provided by the PKI file:
      
          \brief Allows or disallows closing of the WebView.
          
          \param bCanClose, true to allow closing of the WebView, false to disallow.
          
              
      Parameters:
      bCanClose - Takes in a parameter of bCanClose
    • addAllowedExternalFilter

      boolean addAllowedExternalFilter(String filter)
      Information provided by the PKI file:
      
          \brief Adds the specified external filter from the allowed external filter list.
          
          \param filter, the filter to add.
          
          \return bool, true if successful, otherwise false.
          
          \remark Allowed external filters manages which external sites/pages are allowed to access the Script Module. Filters are wildcards and not case sensitive.
          
          \example "http:
          
              
      Parameters:
      filter - Takes in a parameter of filter
      Returns:
      boolean Returns a boolean
    • removeAllowedExternalFilter

      boolean removeAllowedExternalFilter(String filter)
      Information provided by the PKI file:
      
          \brief Removes the specified external filter from the allowed external filter list.
          
          \param filter, the filter of interest.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      filter - Takes in a parameter of filter
      Returns:
      boolean Returns a boolean
    • hasAllowedExternalFilter

      boolean hasAllowedExternalFilter(String filter)
      Information provided by the PKI file:
      
          \brief Returns true if the specified filter is an allowed external filter, otherwise false.
          
          \return bool, true if the specified filter is an allowed external filter, otherwise false.
          
              
      Parameters:
      filter - Takes in a parameter of filter
      Returns:
      boolean Returns a boolean
    • getAllowedExternalFilters

      List<String> getAllowedExternalFilters()
      Information provided by the PKI file:
      
          \brief Returns the list of allowed external filters.
          
          \return vector<QString>, the list of allowed external filters.
          
              
      Returns:
      List<String> Returns a List<String>
    • clearAllowedExternalFilters

      void clearAllowedExternalFilters()
      Information provided by the PKI file:
      
          \brief Clears all allowed external filters.
          
              
    • close

      void close()
      Information provided by the PKI file:
      
          \brief Closes the web view.
          
              
    • attachToMainViewArea

      void attachToMainViewArea()
      Information provided by the PKI file:
      
          \brief Attaches the web view to the main view area. It hides the web view after calling this function. Requires calling show() to show it again.
          
              
    • detachFromMainViewArea

      void detachFromMainViewArea()
      Information provided by the PKI file:
      
          \brief Detaches the web view from the main view area. It hides the web view after calling this function. Requires calling show() to show it again.
          
              
    • isAttachedToMainViewArea

      boolean isAttachedToMainViewArea()
      Information provided by the PKI file:
      
          \brief Returns whether the web view is attached to the main view area.
          
              
      Returns:
      boolean Returns a boolean
    • dockToMainViewArea

      void dockToMainViewArea()
      Information provided by the PKI file:
      
          \brief Docks the web view to the main view area. It hides the web view after calling this function. Requires calling show() to show it again.
          
              
    • undockFromMainViewArea

      void undockFromMainViewArea()
      Information provided by the PKI file:
      
          \brief Undocks the web view from the main view area. It hides the web view after calling this function. Requires calling show() to show it again.
          
              
    • isDockedToMainViewArea

      boolean isDockedToMainViewArea()
      Information provided by the PKI file:
      
          \brief Returns whether the web view is docked to the main view area.
          
              
      Returns:
      boolean Returns a boolean
    • getDockWidgetWindowTitle

      String getDockWidgetWindowTitle()
      Information provided by the PKI file:
      
          \brief Returns the dock widget window title.
          
              
      Returns:
      String Returns a String
    • setDockWidgetWindowTitle

      void setDockWidgetWindowTitle(String title)
      Information provided by the PKI file:
      
          \brief Sets the dock widget window title.
          
          \param title, the title to set for the dock widget window title.
          
              
      Parameters:
      title - Takes in a parameter of title
    • setBackgroundColor

      void setBackgroundColor(long argb)
      Information provided by the PKI file:
      
          \brief Sets the background color of the web view in #AARRGGBB format.
          
          \param argb, the background color in #AARRGGBB format
          
              
      Parameters:
      argb - Takes in a parameter of argb
    • getBackgroundColor

      long getBackgroundColor()
      Information provided by the PKI file:
      
          \brief Returns the background color of the web view in #AARRGGBB format.
          
              
      Returns:
      long Returns a long
    • setZoomFactor

      void setZoomFactor(double factor)
      Information provided by the PKI file:
      
          \brief Sets the zoom factor of this web view, ranging from 0.25 (zoomed out) to 5.0 (zoomed in), with default as 1.0.
          
          \param factor, the zoom factor
          
              
      Parameters:
      factor - Takes in a parameter of factor
    • getZoomFactor

      double getZoomFactor()
      Information provided by the PKI file:
      
          \brief Returns the zoom factor of this web view, ranging from 0.25 (zoomed out) to 5.0 (zoomed in), with default as 1.0.
          
              
      Returns:
      double Returns a double
    • enableRightClickMenu

      void enableRightClickMenu(boolean enable)
      Information provided by the PKI file:
      
          \brief Enables or disables the right click context menu.
          
              
      Parameters:
      enable - Takes in a parameter of enable